Skip to main content

FossID Reporter

FossID

Export reports from FossID.

Configuration​

Example​

{
  "FossID": {
    "options": {
      "serverUrl": null,
      "reportType": "XLSX",
      "selectionType": "INCLUDE_ALL_LICENSES"
    },
    "secrets": {
      "apiKey": null,
      "user": null
    }
  }
}

Options​

serverUrl​

STRING Required

The URL of the FossID server to connect to.

apiKey​

SECRET Required

The API key to use for authentication.

user​

SECRET Required

The user to authenticate as.

reportType​

STRING Default

The type of report to generate. See [ReportType].

selectionType​

STRING Default

The type of selection to use. Allowed values are "INCLUDE_ALL_LICENSES", "INCLUDE_COPYLEFT", "INCLUDE_FOSS", and "INCLUDE_MARKED_LICENSES".